<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    <a name="line.1"></a>
<FONT color="green">002</FONT>    /*<a name="line.2"></a>
<FONT color="green">003</FONT>     * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * $Id: NamedArgumentFormatter.html 69 2011-04-12 02:00:17Z archie.cobbs $<a name="line.5"></a>
<FONT color="green">006</FONT>     */<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    package org.dellroad.stuff.string;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import java.util.ArrayList;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.util.Collections;<a name="line.11"></a>
<FONT color="green">012</FONT>    import java.util.HashMap;<a name="line.12"></a>
<FONT color="green">013</FONT>    import java.util.Map;<a name="line.13"></a>
<FONT color="green">014</FONT>    import java.util.Set;<a name="line.14"></a>
<FONT color="green">015</FONT>    import java.util.regex.Matcher;<a name="line.15"></a>
<FONT color="green">016</FONT>    import java.util.regex.Pattern;<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    /**<a name="line.18"></a>
<FONT color="green">019</FONT>     * Interpreter for printf-style formatting strings that identifies arguments using names rather than indicies.<a name="line.19"></a>
<FONT color="green">020</FONT>     *<a name="line.20"></a>
<FONT color="green">021</FONT>     * &lt;p&gt;<a name="line.21"></a>
<FONT color="green">022</FONT>     * Works just like {@link java.util.Formatter} but arguments are specified using names instead of numbers.<a name="line.22"></a>
<FONT color="green">023</FONT>     * A mapping from argument name to argument value must be provided during the format operation.<a name="line.23"></a>
<FONT color="green">024</FONT>     * &lt;/p&gt;<a name="line.24"></a>
<FONT color="green">025</FONT>     *<a name="line.25"></a>
<FONT color="green">026</FONT>     * @since 1.0.64<a name="line.26"></a>
<FONT color="green">027</FONT>     */<a name="line.27"></a>
<FONT color="green">028</FONT>    public class NamedArgumentFormatter {<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>        private static final Pattern FORMAT_PARAM_PATTERN = Pattern.compile("%(\\w+)\\$");<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>        /**<a name="line.32"></a>
<FONT color="green">033</FONT>         * The list of argument names in the order they are used. This is the inverse mapping of {@link #fieldMap}.<a name="line.33"></a>
<FONT color="green">034</FONT>         */<a name="line.34"></a>
<FONT color="green">035</FONT>        protected final ArrayList&lt;String&gt; fieldList = new ArrayList&lt;String&gt;();<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>        /**<a name="line.37"></a>
<FONT color="green">038</FONT>         * Mapping from argument name to argument list index. This is the inverse mapping of {@link #fieldList}.<a name="line.38"></a>
<FONT color="green">039</FONT>         */<a name="line.39"></a>
<FONT color="green">040</FONT>        protected final HashMap&lt;String, Integer&gt; fieldMap = new HashMap&lt;String, Integer&gt;();<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>        /**<a name="line.42"></a>
<FONT color="green">043</FONT>         * The original format string provided to the constructor.<a name="line.43"></a>
<FONT color="green">044</FONT>         */<a name="line.44"></a>
<FONT color="green">045</FONT>        protected final String originalFormat;<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        /**<a name="line.47"></a>
<FONT color="green">048</FONT>         * The modified format string containing indexes instead of argument names.<a name="line.48"></a>
<FONT color="green">049</FONT>         */<a name="line.49"></a>
<FONT color="green">050</FONT>        protected final String indexedFormat;<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /**<a name="line.52"></a>
<FONT color="green">053</FONT>         * Constructor.<a name="line.53"></a>
<FONT color="green">054</FONT>         *<a name="line.54"></a>
<FONT color="green">055</FONT>         * @param format format string containing argument names instead of indicies<a name="line.55"></a>
<FONT color="green">056</FONT>         */<a name="line.56"></a>
<FONT color="green">057</FONT>        public NamedArgumentFormatter(final String format) {<a name="line.57"></a>
<FONT color="green">058</FONT>            Matcher matcher = FORMAT_PARAM_PATTERN.matcher(format);<a name="line.58"></a>
<FONT color="green">059</FONT>            StringBuilder buf = new StringBuilder();<a name="line.59"></a>
<FONT color="green">060</FONT>            for (int offset = 0; true; offset = matcher.end(1)) {<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>                // Find next conversion<a name="line.62"></a>
<FONT color="green">063</FONT>                if (!matcher.find(offset)) {<a name="line.63"></a>
<FONT color="green">064</FONT>                    buf.append(format.substring(offset));<a name="line.64"></a>
<FONT color="green">065</FONT>                    break;<a name="line.65"></a>
<FONT color="green">066</FONT>                }<a name="line.66"></a>
<FONT color="green">067</FONT>    <a name="line.67"></a>
<FONT color="green">068</FONT>                // Extract argument name<a name="line.68"></a>
<FONT color="green">069</FONT>                String fieldName = matcher.group(1);<a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>                // If we haven't seen this argument name yet, assign it the next parameter index<a name="line.71"></a>
<FONT color="green">072</FONT>                Integer fieldIndex = this.fieldMap.get(fieldName);<a name="line.72"></a>
<FONT color="green">073</FONT>                if (fieldIndex == null) {<a name="line.73"></a>
<FONT color="green">074</FONT>                    fieldIndex = this.fieldList.size();<a name="line.74"></a>
<FONT color="green">075</FONT>                    this.fieldMap.put(fieldName, fieldIndex);<a name="line.75"></a>
<FONT color="green">076</FONT>                    this.fieldList.add(fieldName);<a name="line.76"></a>
<FONT color="green">077</FONT>                }<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>                // Replace field name in format string with parameter index<a name="line.79"></a>
<FONT color="green">080</FONT>                buf.append(format.substring(offset, matcher.start(1)));<a name="line.80"></a>
<FONT color="green">081</FONT>                buf.append(fieldIndex + 1);<a name="line.81"></a>
<FONT color="green">082</FONT>            }<a name="line.82"></a>
<FONT color="green">083</FONT>            this.originalFormat = format;<a name="line.83"></a>
<FONT color="green">084</FONT>            this.indexedFormat = buf.toString();<a name="line.84"></a>
<FONT color="green">085</FONT>        }<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>        /**<a name="line.87"></a>
<FONT color="green">088</FONT>         * Format the string using the given arguments.<a name="line.88"></a>
<FONT color="green">089</FONT>         *<a name="line.89"></a>
<FONT color="green">090</FONT>         * @param argMap mapping from argument name to argument value<a name="line.90"></a>
<FONT color="green">091</FONT>         * @throws IllegalFormatException if the format provided to the constructor contained illegal syntax<a name="line.91"></a>
<FONT color="green">092</FONT>         * @throws IllegalFormatException if an argument value is incompatible or missing (and null would be invalid)<a name="line.92"></a>
<FONT color="green">093</FONT>         */<a name="line.93"></a>
<FONT color="green">094</FONT>        public String format(Map&lt;String, Object&gt; argMap) {<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>            // Put values into format parameter array<a name="line.96"></a>
<FONT color="green">097</FONT>            ArrayList&lt;Object&gt; parameterList = new ArrayList&lt;Object&gt;(this.fieldList.size());<a name="line.97"></a>
<FONT color="green">098</FONT>            for (String fieldName : this.fieldList)<a name="line.98"></a>
<FONT color="green">099</FONT>                parameterList.add(argMap.get(fieldName));<a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>            // Format string<a name="line.101"></a>
<FONT color="green">102</FONT>            return String.format(this.indexedFormat, parameterList.toArray());<a name="line.102"></a>
<FONT color="green">103</FONT>        }<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>        /**<a name="line.105"></a>
<FONT color="green">106</FONT>         * Get the original format string provided to the constructor.<a name="line.106"></a>
<FONT color="green">107</FONT>         */<a name="line.107"></a>
<FONT color="green">108</FONT>        public String getFormat() {<a name="line.108"></a>
<FONT color="green">109</FONT>            return this.originalFormat;<a name="line.109"></a>
<FONT color="green">110</FONT>        }<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>        /**<a name="line.112"></a>
<FONT color="green">113</FONT>         * Get the argument names found in the configured format string.<a name="line.113"></a>
<FONT color="green">114</FONT>         *<a name="line.114"></a>
<FONT color="green">115</FONT>         * @return argument names as a unmodifiable set<a name="line.115"></a>
<FONT color="green">116</FONT>         */<a name="line.116"></a>
<FONT color="green">117</FONT>        public Set&lt;String&gt; getArgumentNames() {<a name="line.117"></a>
<FONT color="green">118</FONT>            return Collections.unmodifiableSet(this.fieldMap.keySet());<a name="line.118"></a>
<FONT color="green">119</FONT>        }<a name="line.119"></a>
<FONT color="green">120</FONT>    }<a name="line.120"></a>
<FONT color="green">121</FONT>    <a name="line.121"></a>




























































</PRE>
</BODY>
</HTML>
